Batch Upload API

POST Upload

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The Upload API endpoint is designed to facilitate the process of uploading files into the SureTax system. This endpoint requires the inclusion of a specific header called X-Import-Type to specify the type of file being uploaded. In the body of the API request, the following parameters need to be included:

1. legalEntityCode: This parameter represents the code or identifier for the legal entity associated with the uploaded file.

2. DatayearMonth: This parameter specifies the year and month associated with the data being uploaded.

3. filelayoutversion: This parameter indicates the version or format of the file being uploaded.

It ensures that the SureTax system can correctly interpret and process the data within the file. By utilizing this upload API endpoint, users can seamlessly transfer their files into the SureTax system.

OperationId: POST Upload

Authorization Method(s): OAuth

Verb: POST

End Point: /api/v1/Batch/Upload

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
File Content *	fileContent	string
Request Data *	requestData	RequestDataDetails

RequestDataDetails

Display Name	Field Name	Field Type
Legal Entity Code *	legalEntityCode	string
File Layout Version *	fileLayoutVersion	string
Data Year Month *	dataYearMonth	string
Compliance Year Month	complianceYearMonth	string
Configuration Name	configurationName	string

Example Request

The following is an json request for this operation.

{
  "legalEntityCode": "B000112005",
  "fileLayoutVersion": "1.0",
  "dataYearMonth": "202501"
}

Request Headers

Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.

Display String	Field Name	Field Type
X-request-id*	x-request-id	string
X-import-type*	x-import-type	string

*Mandatory parameter

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
202	The API responds with this code to indicate that the data was sent successfully.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Batch/Upload

Add Request Headers:

Add File:Select Batch FileNo file chosen

{
  "legalEntityCode": "B000112005",
  "fileLayoutVersion": "1.0",
  "dataYearMonth": "202501"
}

Batch Upload API

POST Upload

Overview

Example Request

Enter Environment Credentials